<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="alloydb_v1beta.html">AlloyDB API</a> . <a href="alloydb_v1beta.projects.html">projects</a> . <a href="alloydb_v1beta.projects.locations.html">locations</a> . <a href="alloydb_v1beta.projects.locations.backups.html">backups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, backupId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Backup in a given project and location.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Backup.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Backup.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Backups in a given project and location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Backup.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, backupId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
  <pre>Creates a new Backup in a given project and location.

Args:
  parent: string, Required. Value for parent. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing Backup object
  &quot;annotations&quot;: { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;clusterName&quot;: &quot;A String&quot;, # Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
  &quot;clusterUid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the cluster which was used to create this resource.
  &quot;createCompletionTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the resource finished being created.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time stamp
  &quot;databaseVersion&quot;: &quot;A String&quot;, # Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
  &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. Delete time stamp
  &quot;description&quot;: &quot;A String&quot;, # User-provided description of the backup.
  &quot;displayName&quot;: &quot;A String&quot;, # User-settable and human-readable display name for the Backup.
  &quot;encryptionConfig&quot;: { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  },
  &quot;encryptionInfo&quot;: { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the backup.
    &quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Type of encryption.
    &quot;kmsKeyVersions&quot;: [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
      &quot;A String&quot;,
    ],
  },
  &quot;etag&quot;: &quot;A String&quot;, # For Resource freshness validation (https://google.aip.dev/154)
  &quot;expiryQuantity&quot;: { # A backup&#x27;s position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup&#x27;s retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) # Output only. The QuantityBasedExpiry of the backup, specified by the backup&#x27;s retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    &quot;retentionCount&quot;: 42, # Output only. The backup&#x27;s position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    &quot;totalRetentionCount&quot;: 42, # Output only. The length of the quantity-based queue, specified by the backup&#x27;s retention policy.
  },
  &quot;expiryTime&quot;: &quot;A String&quot;, # Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup&#x27;s retention policy, added to the backup&#x27;s create_time.
  &quot;labels&quot;: { # Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
  &quot;reconciling&quot;: True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the backup in bytes.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
  &quot;tags&quot;: { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` &quot;123/environment&quot;: &quot;production&quot;, &quot;123/costCenter&quot;: &quot;marketing&quot; ```
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;type&quot;: &quot;A String&quot;, # The backup type, which suggests the trigger for the backup.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.
}

  backupId: string, Required. ID of the requesting object.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn&#x27;t actually execute it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
  <pre>Deletes a single Backup.

Args:
  name: string, Required. Name of the resource. For the required format, see the comment on the Backup.name field. (required)
  etag: string, Optional. The current etag of the Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn&#x27;t actually execute it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single Backup.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing Backup object
  &quot;annotations&quot;: { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;clusterName&quot;: &quot;A String&quot;, # Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
  &quot;clusterUid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the cluster which was used to create this resource.
  &quot;createCompletionTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the resource finished being created.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time stamp
  &quot;databaseVersion&quot;: &quot;A String&quot;, # Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
  &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. Delete time stamp
  &quot;description&quot;: &quot;A String&quot;, # User-provided description of the backup.
  &quot;displayName&quot;: &quot;A String&quot;, # User-settable and human-readable display name for the Backup.
  &quot;encryptionConfig&quot;: { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  },
  &quot;encryptionInfo&quot;: { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the backup.
    &quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Type of encryption.
    &quot;kmsKeyVersions&quot;: [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
      &quot;A String&quot;,
    ],
  },
  &quot;etag&quot;: &quot;A String&quot;, # For Resource freshness validation (https://google.aip.dev/154)
  &quot;expiryQuantity&quot;: { # A backup&#x27;s position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup&#x27;s retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) # Output only. The QuantityBasedExpiry of the backup, specified by the backup&#x27;s retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    &quot;retentionCount&quot;: 42, # Output only. The backup&#x27;s position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    &quot;totalRetentionCount&quot;: 42, # Output only. The length of the quantity-based queue, specified by the backup&#x27;s retention policy.
  },
  &quot;expiryTime&quot;: &quot;A String&quot;, # Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup&#x27;s retention policy, added to the backup&#x27;s create_time.
  &quot;labels&quot;: { # Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
  &quot;reconciling&quot;: True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the backup in bytes.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
  &quot;tags&quot;: { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` &quot;123/environment&quot;: &quot;production&quot;, &quot;123/costCenter&quot;: &quot;marketing&quot; ```
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;type&quot;: &quot;A String&quot;, # The backup type, which suggests the trigger for the backup.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists Backups in a given project and location.

Args:
  parent: string, Required. Parent value for ListBackupsRequest (required)
  filter: string, Filtering results
  orderBy: string, Hint for how to order the results
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing Backups
  &quot;backups&quot;: [ # The list of Backup
    { # Message describing Backup object
      &quot;annotations&quot;: { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;clusterName&quot;: &quot;A String&quot;, # Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
      &quot;clusterUid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the cluster which was used to create this resource.
      &quot;createCompletionTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the resource finished being created.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time stamp
      &quot;databaseVersion&quot;: &quot;A String&quot;, # Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
      &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. Delete time stamp
      &quot;description&quot;: &quot;A String&quot;, # User-provided description of the backup.
      &quot;displayName&quot;: &quot;A String&quot;, # User-settable and human-readable display name for the Backup.
      &quot;encryptionConfig&quot;: { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
        &quot;kmsKeyName&quot;: &quot;A String&quot;, # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
      },
      &quot;encryptionInfo&quot;: { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the backup.
        &quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Type of encryption.
        &quot;kmsKeyVersions&quot;: [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
          &quot;A String&quot;,
        ],
      },
      &quot;etag&quot;: &quot;A String&quot;, # For Resource freshness validation (https://google.aip.dev/154)
      &quot;expiryQuantity&quot;: { # A backup&#x27;s position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup&#x27;s retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) # Output only. The QuantityBasedExpiry of the backup, specified by the backup&#x27;s retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
        &quot;retentionCount&quot;: 42, # Output only. The backup&#x27;s position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
        &quot;totalRetentionCount&quot;: 42, # Output only. The length of the quantity-based queue, specified by the backup&#x27;s retention policy.
      },
      &quot;expiryTime&quot;: &quot;A String&quot;, # Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup&#x27;s retention policy, added to the backup&#x27;s create_time.
      &quot;labels&quot;: { # Labels as key value pairs
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
      &quot;reconciling&quot;: True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
      &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
      &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the backup in bytes.
      &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
      &quot;tags&quot;: { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` &quot;123/environment&quot;: &quot;production&quot;, &quot;123/costCenter&quot;: &quot;marketing&quot; ```
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;type&quot;: &quot;A String&quot;, # The backup type, which suggests the trigger for the backup.
      &quot;uid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
  <pre>Updates the parameters of a single Backup.

Args:
  name: string, Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region} (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing Backup object
  &quot;annotations&quot;: { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;clusterName&quot;: &quot;A String&quot;, # Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
  &quot;clusterUid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the cluster which was used to create this resource.
  &quot;createCompletionTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the resource finished being created.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time stamp
  &quot;databaseVersion&quot;: &quot;A String&quot;, # Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
  &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. Delete time stamp
  &quot;description&quot;: &quot;A String&quot;, # User-provided description of the backup.
  &quot;displayName&quot;: &quot;A String&quot;, # User-settable and human-readable display name for the Backup.
  &quot;encryptionConfig&quot;: { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  },
  &quot;encryptionInfo&quot;: { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the backup.
    &quot;encryptionType&quot;: &quot;A String&quot;, # Output only. Type of encryption.
    &quot;kmsKeyVersions&quot;: [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
      &quot;A String&quot;,
    ],
  },
  &quot;etag&quot;: &quot;A String&quot;, # For Resource freshness validation (https://google.aip.dev/154)
  &quot;expiryQuantity&quot;: { # A backup&#x27;s position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup&#x27;s retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) # Output only. The QuantityBasedExpiry of the backup, specified by the backup&#x27;s retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
    &quot;retentionCount&quot;: 42, # Output only. The backup&#x27;s position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
    &quot;totalRetentionCount&quot;: 42, # Output only. The length of the quantity-based queue, specified by the backup&#x27;s retention policy.
  },
  &quot;expiryTime&quot;: &quot;A String&quot;, # Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup&#x27;s retention policy, added to the backup&#x27;s create_time.
  &quot;labels&quot;: { # Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
  &quot;reconciling&quot;: True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the backup in bytes.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
  &quot;tags&quot;: { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` &quot;123/environment&quot;: &quot;production&quot;, &quot;123/costCenter&quot;: &quot;marketing&quot; ```
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;type&quot;: &quot;A String&quot;, # The backup type, which suggests the trigger for the backup.
  &quot;uid&quot;: &quot;A String&quot;, # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.
}

  allowMissing: boolean, Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  validateOnly: boolean, Optional. If set, the backend validates the request, but doesn&#x27;t actually execute it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>